docs: clarify documentation workflow#6739
Open
abdollahShahid wants to merge 1 commit intopipe-cd:masterfrom
Open
docs: clarify documentation workflow#6739abdollahShahid wants to merge 1 commit intopipe-cd:masterfrom
abdollahShahid wants to merge 1 commit intopipe-cd:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Clarifies the documentation contribution workflow in docs/README.md, including updating the versioned docs example to a generalized docs-vX.Y.x.
Changes:
- Fixes wording/grammar in the intro and workflow sections.
- Updates the versioned docs path example from
docs-v0.x.xtodocs-vX.Y.x. - Tweaks local Hugo prerequisite wording.
Signed-off-by: Muhammad Abdullah Shahid <108458621+abdollahShahid@users.noreply.github.com>
abdollahShahid
force-pushed
the
docs-readme-workflow-clarification
branch
from
2ea72ea to
c3a4626
Compare
Ayushmore1214
approved these changes
May 6, 2026
Contributor
Ayushmore1214
left a comment
Ayushmore1214
left a comment
There was a problem hiding this comment.
great work @abdollahShahid LGTM!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR makes a small clarification update to
docs/README.md. It fixes a few wording issues, updates the versioned docs example fromdocs-v0.x.xto the more generaldocs-vX.Y.x, and makes the docs contribution workflow section easier to read.Refs #6679